Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update model function names #55

Merged
merged 13 commits into from
Nov 9, 2023
Merged

Update model function names #55

merged 13 commits into from
Nov 9, 2023

Conversation

amanda-minter
Copy link
Collaborator

Function names in {epidemics} are now model_X() following this PR

Function names in `{epidemics}` are now `model_X()`
Copy link

github-actions bot commented Nov 7, 2023

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/epiverse-trace/tutorials/compare/md-outputs..md-outputs-PR-55

The following changes were observed in the rendered markdown documents:

 compare-interventions.md                        |   5 +--
 fig/simulating-transmission-rendered-plot-1.png | Bin 14897 -> 14781 bytes
 md5sum.txt                                      |   8 ++--
 model-choices.md                                |  16 ++++----
 modelling-interventions.md                      |  41 ++++---------------
 simulating-transmission.md                      |  50 +++++++-----------------
 6 files changed, 35 insertions(+), 85 deletions(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2023-11-09 13:33:19 +0000

github-actions bot pushed a commit that referenced this pull request Nov 7, 2023
@pratikunterwegs pratikunterwegs removed their request for review November 7, 2023 10:33
@avallecam
Copy link
Member

avallecam commented Nov 8, 2023

I will need more time to look into this. Possibly on Friday or next Monday. Does it work for you?

@amanda-minter
Copy link
Collaborator Author

Please take a look as soon as you can, this is high priority as it affects the live site examples and is a blocker for @CarmenTamayo to review the materials.

Copy link
Member

@avallecam avallecam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the replacement of model_ebola_r instead of the model_ebola_cpp is coherent?

From the vignette, in the "Run epidemic model" subtitle:

We run the model using the function model_ebola_r(). While there is a C++ equivalent of this model, it was not found to be much faster than the R-only version, and is not made available to users.

episodes/model-choices.Rmd Outdated Show resolved Hide resolved
episodes/model-choices.Rmd Outdated Show resolved Hide resolved
episodes/model-choices.Rmd Outdated Show resolved Hide resolved
episodes/model-choices.Rmd Outdated Show resolved Hide resolved
Function names in `{epidemics}` are now `model_X()`
github-actions bot pushed a commit that referenced this pull request Nov 9, 2023
@avallecam
Copy link
Member

I did the step of "Update with rebase" here on GitHub. So if you need to make new changes locally, probably you need to pull content first? Let me know if this generates any issues.

github-actions bot pushed a commit that referenced this pull request Nov 9, 2023
github-actions bot pushed a commit that referenced this pull request Nov 9, 2023
amanda-minter and others added 5 commits November 9, 2023 13:28
Function names in `{epidemics}` are now `model_X()`
Co-authored-by: Andree Valle Campos <[email protected]>
Co-authored-by: Andree Valle Campos <[email protected]>
Co-authored-by: Andree Valle Campos <[email protected]>
github-actions bot pushed a commit that referenced this pull request Nov 9, 2023
@avallecam
Copy link
Member

avallecam commented Nov 9, 2023

I see a "branch cannot be rebased due to conflicts". I'm afraid that if it is not possible to resolve conflicts, then we should "squash and merge" for this one, again.

I think I will avoid the "Update with rebase" option in GitHub, and we as developers can do the rebasing in the local repos only by running git pull origin main to rebase the feature branch. I'll update on this in a separate issue/PR.

@amanda-minter
Copy link
Collaborator Author

I see a "branch cannot be rebased due to conflicts". I'm afraid that if it is not possible to resolve conflicts, then we should "squash and merge" for this one, again.

I think I will avoid the "Update with rebase" option in GitHub, and we as developers can do the rebasing in the local repos only by running git pull origin main to rebase the feature branch. I'll update on this in a separate issue/PR.

Thanks Andree, I will have to squash and merge this PR

@amanda-minter amanda-minter merged commit f8d1060 into main Nov 9, 2023
3 checks passed
@amanda-minter amanda-minter deleted the update-model-names branch November 9, 2023 15:01
github-actions bot pushed a commit that referenced this pull request Nov 9, 2023
Auto-generated via {sandpaper}
Source  : f8d1060
Branch  : main
Author  : Amanda Minter <[email protected]>
Time    : 2023-11-09 15:01:14 +0000
Message : Update model function names (#55)

* Update model function names

Function names in `{epidemics}` are now `model_X()`

* Update model function names

Function names in `{epidemics}` are now `model_X()`

* Update episodes/model-choices.Rmd

Co-authored-by: Andree Valle Campos <[email protected]>

* Update episodes/model-choices.Rmd

Co-authored-by: Andree Valle Campos <[email protected]>

* Update episodes/model-choices.Rmd

Co-authored-by: Andree Valle Campos <[email protected]>

* Add checklist link

* Update model function names

Function names in `{epidemics}` are now `model_X()`

* Update episodes/model-choices.Rmd

Co-authored-by: Andree Valle Campos <[email protected]>

* Update episodes/model-choices.Rmd

Co-authored-by: Andree Valle Campos <[email protected]>

* Update episodes/model-choices.Rmd

Co-authored-by: Andree Valle Campos <[email protected]>

* Add checklist link

---------

Co-authored-by: Andree Valle Campos <[email protected]>
github-actions bot pushed a commit that referenced this pull request Nov 9, 2023
Auto-generated via {sandpaper}
Source  : 6a660e9
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-09 15:04:45 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : f8d1060
Branch  : main
Author  : Amanda Minter <[email protected]>
Time    : 2023-11-09 15:01:14 +0000
Message : Update model function names (#55)

* Update model function names

Function names in `{epidemics}` are now `model_X()`

* Update model function names

Function names in `{epidemics}` are now `model_X()`

* Update episodes/model-choices.Rmd

Co-authored-by: Andree Valle Campos <[email protected]>

* Update episodes/model-choices.Rmd

Co-authored-by: Andree Valle Campos <[email protected]>

* Update episodes/model-choices.Rmd

Co-authored-by: Andree Valle Campos <[email protected]>

* Add checklist link

* Update model function names

Function names in `{epidemics}` are now `model_X()`

* Update episodes/model-choices.Rmd

Co-authored-by: Andree Valle Campos <[email protected]>

* Update episodes/model-choices.Rmd

Co-authored-by: Andree Valle Campos <[email protected]>

* Update episodes/model-choices.Rmd

Co-authored-by: Andree Valle Campos <[email protected]>

* Add checklist link

---------

Co-authored-by: Andree Valle Campos <[email protected]>
github-actions bot pushed a commit that referenced this pull request Nov 14, 2023
Auto-generated via {sandpaper}
Source  : 6a660e9
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-09 15:04:45 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : f8d1060
Branch  : main
Author  : Amanda Minter <[email protected]>
Time    : 2023-11-09 15:01:14 +0000
Message : Update model function names (#55)

* Update model function names

Function names in `{epidemics}` are now `model_X()`

* Update model function names

Function names in `{epidemics}` are now `model_X()`

* Update episodes/model-choices.Rmd

Co-authored-by: Andree Valle Campos <[email protected]>

* Update episodes/model-choices.Rmd

Co-authored-by: Andree Valle Campos <[email protected]>

* Update episodes/model-choices.Rmd

Co-authored-by: Andree Valle Campos <[email protected]>

* Add checklist link

* Update model function names

Function names in `{epidemics}` are now `model_X()`

* Update episodes/model-choices.Rmd

Co-authored-by: Andree Valle Campos <[email protected]>

* Update episodes/model-choices.Rmd

Co-authored-by: Andree Valle Campos <[email protected]>

* Update episodes/model-choices.Rmd

Co-authored-by: Andree Valle Campos <[email protected]>

* Add checklist link

---------

Co-authored-by: Andree Valle Campos <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants